Skip to content

First pass at addressing cross-compiler compatibility in MISRA 2023. #884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

MichaelRFairhurst
Copy link
Contributor

@MichaelRFairhurst MichaelRFairhurst commented Apr 8, 2025

Handles clang findings and gcc findings.

Many issues were merely updates to the test cases, however, additional work has been done to properly handle tgmath.h and stdatomic.h macros across gcc and clang results.

Description

please enter the description of your change here

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • rule number here
  • Queries have been modified for the following rules:
    • DIR-4-15, RULE-9-7, RULE-13-2, RULE-21-22, RULE-21-23, RULE-21-25

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Handles clang findings and gcc findings.

Many issues were merely updates to the test cases, however, additional
work has been done to properly handle tgmath.h and stdatomic.h macros
across gcc and clang results.
@Copilot Copilot AI review requested due to automatic review settings April 8, 2025 22:19
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses various cross-compiler issues related to MISRA 2023 compliance by adjusting test cases and fixing macro-related test behaviors. Key changes include updates to variably-modified array declarations, correction of memset argument orders, and standardization of main() signatures across tests.

Reviewed Changes

Copilot reviewed 30 out of 41 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
c/misra/test/rules/RULE-18-8/test.c Adjusted VLA array parameter declaration to include dimension size.
c/misra/test/rules/RULE-18-10/test.c Updated array declarations and removed an invalid array initialization assignment.
c/misra/test/rules/RULE-17-11/test.c Corrected main() signature to standard format.
c/misra/test/rules/RULE-12-6/test.c Corrected memset argument order to (destination, value, size) in multiple locations.
c/misra/test/rules/DIR-5-3/test.c Updated main() signature for proper standard compliance.
c/misra/test/rules/DIR-5-1/test.c Updated main() signature to comply with standard signature requirements.
c/common/test/rules/functionnoreturnattributecondition/test.c Minor formatting update in the default case of a switch statement.
Files not reviewed (11)
  • c/common/src/codingstandards/c/TgMath.qll: Language not supported
  • c/misra/src/rules/RULE-13-2/UnsequencedAtomicReads.ql: Language not supported
  • c/misra/src/rules/RULE-21-22/TgMathArgumentWithInvalidEssentialType.ql: Language not supported
  • c/misra/src/rules/RULE-21-23/TgMathArgumentsWithDifferingStandardType.ql: Language not supported
  • c/misra/src/rules/RULE-21-25/InvalidMemoryOrderArgument.ql: Language not supported
  • c/misra/src/rules/RULE-9-7/UninitializedAtomicObject.ql: Language not supported
  • c/misra/test/rules/RULE-1-5/UseOfObsoleteMacroAtomicVarInit.expected.gcc: Language not supported
  • c/misra/test/rules/RULE-11-10/test.c.clang: Language not supported
  • c/misra/test/rules/RULE-12-6/test.c.clang: Language not supported
  • c/misra/test/rules/RULE-13-2/UnsequencedAtomicReads.expected: Language not supported
  • c/misra/test/rules/RULE-13-2/UnsequencedAtomicReads.expected.gcc: Language not supported
Comments suppressed due to low confidence (1)

c/misra/test/rules/RULE-18-10/test.c:75

  • The assignment of a pointer to initialize an array is invalid. The change to remove the assignment helps prevent compilation errors.
int l6[10] = p23;

@MichaelRFairhurst
Copy link
Contributor Author

Confirmed that new MISRA C rules are passing in CI/CD for gcc and clang at this ref.

Copy link
Collaborator

@lcartey lcartey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than what's possibly a stray semi-colon, looks good to me!

@MichaelRFairhurst MichaelRFairhurst added this pull request to the merge queue Apr 30, 2025
Merged via the queue into main with commit a088de2 Apr 30, 2025
25 checks passed
@MichaelRFairhurst MichaelRFairhurst deleted the michaelrfairhurst/address-compiler-compatibility-issue-misra-c-2023 branch April 30, 2025 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants